docs: improve observability / monitoring documentation#310
Open
Georg (D3luxee) wants to merge 15 commits into
Open
docs: improve observability / monitoring documentation#310Georg (D3luxee) wants to merge 15 commits into
Georg (D3luxee) wants to merge 15 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for the Multiplayer Servers “observability tap” feature and links it into the Monitoring sidebar, so readers can discover how to access Prometheus-compatible metrics and Loki-compatible logs endpoints.
Changes:
- Adds a new Monitoring page describing observability tap access, endpoints, and Grafana data source setup.
- Adds a new sidebar navigation entry under Monitoring for the new page.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| src/multiplayer-servers/monitoring/sidebar.json | Adds a new sidebar item linking to the observability tap page. |
| src/multiplayer-servers/monitoring/obs-tap.md | Introduces the observability tap documentation, including endpoints and Grafana setup steps. |
Christian R (antiphp)
left a comment
Christian R (antiphp)
left a comment
Contributor
There was a problem hiding this comment.
What AI says and:
- For me "tap" is not a familiar term. If it is, ignore me.
- Wonder if you want to mention what metrics the user can expect, GameFabric metrics or Agones Cluster metrics, or both. Maybe add one example each, so the user has a starting point?
- Same for the Loki endpoints. Just a sentence that it allows accessing the game server logs, see further details here/there (if we have something to link).
Blex (BlexToGo)
requested changes
Jun 24, 2026
| ### Metrics data source | ||
|
|
||
| 1. In Grafana, go to **Connections > Data sources** and select **Add new data source**. | ||
| 1. Choose **Prometheus** as the data source type. |
Contributor
There was a problem hiding this comment.
What's up with the 1. 1. 1. 1. numeration here? Maybe the markdown renderer will auto-fix this, but I'm not sure
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Co-authored-by: Blex <[email protected]>
Co-authored-by: Blex <[email protected]>
|
|
||
| The metrics endpoint is compatible with the [VictoriaMetrics MetricsQL](https://docs.victoriametrics.com/metricsql/) query language, which is a superset of PromQL. Any tool that supports PromQL also works against this endpoint. | ||
|
|
||
| The following Prometheus HTTP API paths are available under the metrics endpoint: |
Co-authored-by: Blex <[email protected]>
Co-authored-by: Blex <[email protected]>
Co-authored-by: Blex <[email protected]>
Co-authored-by: Blex <[email protected]>
Co-authored-by: Blex <[email protected]>
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
Georg (D3luxee)
changed the title
Comment on lines
+65
to
+70
| 1. In Grafana, go to **Connections > Data sources** and select **Add new data source**. | ||
| 1. Choose **Prometheus** as the data source type. | ||
| 1. Set the **URL** to `https://<your-installation>.gamefabric.dev/observability/metrics/`. | ||
| 4. Under **Authentication**, set the **Authentication method** to **No authentication** | ||
| 5. Under **HTTP headers**, click **Add header** and set **Header** to `Authorization` and **Value** to `Bearer <token>`. Replace `<token>` with the token you receive from your Customer Success Manager. Keep the `Bearer` prefix. | ||
| 1. Select **Save & test** to verify the connection. |
Contributor
There was a problem hiding this comment.
In other parts of our docs, like for example https://github.com/GameFabric/docs/blob/main/src/multiplayer-servers/getting-started/quickstart.md?plain=1#L83-L87, we use manual numbering. Auto-numbering might also work, but for consistency and to be on the safe side, I would lean more towards manual numbering.
Comment on lines
+74
to
+79
| 1. In Grafana, go to **Connections > Data sources** and select **Add new data source**. | ||
| 1. Choose **Loki** as the data source type. | ||
| 1. Set the **URL** to `https://<your-installation>.gamefabric.dev/observability/logs/`. | ||
| 4. Under **Authentication**, set the **Authentication method** to **No authentication** | ||
| 5. Under **HTTP headers**, click **Add header** and set **Header** to `Authorization` and **Value** to `Bearer <token>`. Replace `<token>` with the token you receive from your Customer Success Manager. Keep the `Bearer` prefix. | ||
| 1. Select **Save & test** to verify the connection. |
| 3. Set the **URL** to `https://<your-installation>.gamefabric.dev/observability/metrics/`. | ||
| 4. Under **Authentication**, set the **Authentication method** to **No authentication** | ||
| 5. Under **HTTP headers**, click **Add header** and set **Header** to `Authorization` and **Value** to `Bearer <token>`. Replace `<token>` with the token you receive from your Customer Success Manager. Keep the `Bearer` prefix. | ||
| 1. Select **Save & test** to verify the connection. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Goal of this PR
Improve monitoring / observability documentation